home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / icon tools / iconconvert / iconconvert.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  14KB  |  364 lines
  1. @database 0013e2b0-0
  2. @master IconConvert.guide
  3. @$VER: 1.2
  4. @author "Peter Liljenberg"
  5. @(c) "1995 Peter Liljenberg"
  6. @remark Created with Heddley v1.1 (c) Edd Dumbill 1994
  7. @node "Main" "IconConvert"
  8. @next "intro"
  9.                                @{fg shine}IconConvert v1.2@{fg text}
  10.                        @{b}Copyright 
  11. 1995 Peter Liljenberg@{ub}
  12.                         @{"
  13. Introduction
  14. " link "intro" 0}  What is it -- and why?
  15.                         @{"
  16. Installation
  17. " link "install" 0}  Really simple
  18.                         @{"
  19. Requirements
  20. " link "requirements" 0}  An Amiga
  21.                          @{"
  22. Legal
  23. Stuff
  24. " link "legal" 0}  The usual stuff
  25.                          @{"
  26. General
  27. " link "gen_operation" 0}  Use the program
  28.                        @{"
  29. Workbench
  30. " link "workbench_use" 0}  Use the mouse
  31.                            @{"
  32. Shell
  33. " link "shell_use" 0}  Use the keyboard
  34.                                 @{"
  35. " link "bugs" 0}  Smeg'em
  36.                                @{"
  37. " link "to_do" 0}  The future of IconConvert
  38.                      @{"
  39. Version
  40. History
  41. " link "history" 0}  The past of IconConvert
  42.                @{"
  43. Contacting
  44. Author
  45. " link "contact" 0}  Communicate
  46.           GUI created with triton.library Copyright 
  47.  Stefan Zeiger
  48. @endnode
  49. @node "intro" "Introduction"
  50. @next "install"
  51. @prev "Main"
  52.     Introduction
  53.     ~~~~~~~~~~~~
  54. Icons makes your Amiga more friendly, but finding a set of icons you
  55. actually like is very difficult. Commodore's (RIP) icons are terribly ugly,
  56. the NewIcon system is a good idea but it is slow and it uses a little too
  57. much memory of my precious kilobytes. I had settled on MacigWB's icons, but
  58. I wasn't happy with its demand for an eight colour screen (every kilobyte is
  59. sacred when you only have 2Mb memory.) So I wrote IconConvert to convert
  60. MagicWB's eight colour icons to four colour ones. Now I'm happy.
  61. IconConvert's task is to convert the images of icons between different
  62. palettes. You can also use it to strip superfluous image planes from icons,
  63. and thus save space and time when opening drawers in the Workbench.
  64. IconConvert converts the icons by changing the colours so that the original
  65. image is kept, even if the new image has fewer image planes or a different
  66. palette.
  67. @endnode
  68. @node "install" "Installation"
  69. @next "requirements"
  70. @prev "intro"
  71.     Installation
  72.     ~~~~~~~~~~~~
  73. Installation is very simple. Just copy IconConvert wherever you want, and
  74. copy triton.library (in drawer Triton) to LIBS:. You can use the installer
  75. script in the Triton drawer for this.
  76. @endnode
  77. @node "requirements" "Requirements"
  78. @next "legal"
  79. @prev "install"
  80.     Requirements
  81.     ~~~~~~~~~~~~
  82.  * At least OS 2.04+. OS 3.0+ will improve the performance of IconConvert.
  83.  * 150 - 200 kb free memory, the more the better.
  84.  * Triton library, v3 (release 1.2) or better.
  85. IconConvert has been tested on the following setup:
  86.  * A1200, 020, 2Mb chipmem, 85 Mb hard disk, OS 3.0, with MungWall running.
  87. @endnode
  88. @node "legal" "Legal Stuff"
  89. @next "gen_operation"
  90. @prev "requirements"
  91.     Legal Stuff
  92.     ~~~~~~~~~~~
  93. IconConvert is FreeWare. You can distribute the unmodified archive freely as
  94. long as you don't charge more than a nominal fee, say $5.
  95. @{b}The author takes no responsibility for any damage or loss of data caused by
  96. use of IconConvert. Use of IconConvert is at the user's own risk.@{ub}
  97. IconConvert is Copyright 
  98. 1995 Peter Liljenberg. All rights reserved.
  99. Triton is Copyright 
  100.  Stefan Ziegel.
  101. @endnode
  102. @node "gen_operation" "General Use"
  103. @next "workbench_use"
  104. @prev "legal"
  105.     General Use
  106.     ~~~~~~~~~~~
  107. You choose one or more icons (files ending with ".info") or directories. You
  108. must also have an in palette and an out palette, either the Workbench screen
  109. palette or a palette from an ILBM file.
  110. IconConvert will by default use the Workbench screen palette for both
  111. palettes. Note: If the in palette has fewer colours (smaller image depth)
  112. than the icons you want to convert, IconConvert can't convert correctly
  113. since it won't consider the colours it hasn't information for.
  114. Now will IconConvert work out how to convert colours between the palettes,
  115. and then convert all choosen icons and the icons in the choosen directories.
  116. The icons in all subdirectories can also be converted, if specified.
  117. The new icons will replace the old, if you don't specify that IconConvert
  118. should backup the originals. If you do, IconConvert will save the old icons
  119. with the extension ".oldinfo".
  120. @endnode
  121. @node "workbench_use" "Workbench Use"
  122. @next "shell_use"
  123. @prev "gen_operation"
  124.     Workbench Use
  125.     ~~~~~~~~~~~~~
  126. Double click on IconConvert to start. You can choose icons and directories
  127. at the start by clicking once on IconConvert, and then shift click (hold
  128. down shift and click) on icons and drawers, and then double click on the
  129. last icon/drawer to start IconConvert. You can also drop icons and drawers
  130. on the main window -- it's an AppWindow. You can define which palettes to
  131. use and some of the options with the @{"tooltypes" link "tooltypes" 0} in the program icon.
  132. Now two windows will be opened. The main window and the conversion settings
  133. window.
  134.     @{"Main
  135. window" link "main_win" 0}
  136.     @{"Conversion
  137. settings
  138. window" link "conv_win" 0}
  139.     @{"Palette
  140. window" link "palette_win" 0}
  141.     @{"Conversion
  142. window" link "convmap_win" 0}
  143.     @{"Progress
  144. window" link "progress_win" 0}
  145. @endnode
  146. @node "tooltypes" "ToolTypes"
  147. @next "main_win"
  148. @prev "workbench_use"
  149.     ToolTypes
  150.     ~~~~~~~~~
  151. By defining tooltypes in the program's icon you can change the default
  152. settings at startup.
  153.  INPAL    -- Use the palette in the specified ILBM file as in palette. It 
  154.              is a good idea to use "ENV:Sys/palette.ilbm" here. It has 16
  155.              colours, so if you once have had MagicWB the first eight
  156.              colours will be MagicWB's which makes it easy to convert 
  157.              MagicWB icons to four colours when you have a four colour 
  158.              screen.
  159.  OUTPAL   -- Use the palette in the specified ILBM file as out palette.
  160.  DEPTH    -- The depth of the resulting icons. Must be within 1 to 8.
  161.  ALL      -- Convert icons in subdirectories to choosen directories.
  162.  SAVEOLD  -- Backup the old icons with the extension ".oldinfo".
  163.  DIRICONS -- Add the drawer icons to chosen directories.
  164. @endnode
  165. @node "main_win" "Main Window"
  166. @next "conv_win"
  167. @prev "workbench_use"
  168.     Main Window
  169.     ~~~~~~~~~~~
  170. Gadgets:
  171.     Icons   -- A listview gadget showing all choosen icons and dirs. You 
  172.                can use the cursor keys to scroll the list.
  173.     Add     -- Click on the button to add icons to icon list. A file
  174.                requester opens where you can choose icons. Shiftclick to
  175.                choose more than one icon.
  176.     Add Dir -- Add a directory to the list. Choose the directory in the
  177.                requester.
  178.     Remove  -- Remove the selected icon/directory from the list.
  179.     Add Drawer Icons -- When you add a dir it's drawer icon will be added 
  180.                to the list too, if set.
  181.     Convert -- Start conversion.
  182. Menus:
  183.   Icon:
  184.     Add        -- See above.
  185.     Add Dir    -- See above.
  186.     Remove     -- See above.
  187.     Remove All -- Remove all icons/directories from the list.
  188.     Convert    -- See above.
  189.     About      -- Pop up a requester with some information.
  190.     Quit       -- Quit IconConvert.
  191.   Palette:
  192.     Edit In Palette  -- Open in @{"palette
  193. window" link "palette_win" 0}.
  194.     Edit Out Palette -- Open out @{"palette
  195. window" link "palette_win" 0}.
  196. Drop icons and drawers on the window to add them to the list.
  197. Clicking on the close gadget will quit IconConvert.
  198. @endnode
  199. @node "conv_win" "Conversion Settings Window"
  200. @next "palette_win"
  201. @prev "main_win"
  202.     Conversion Settings Window
  203.     ~~~~~~~~~~~~~~~~~~~~~~~~~~
  204. Gadgets:
  205.     Show Conv. Map -- Show @{"conversion
  206. window" link "convmap_win" 0} before conversion,
  207.                       allowing you to alter it.
  208.     Enter Subdirs  -- Convert icons in subdirectories to choosen
  209.                       directories.
  210.     Save old icons -- Save the old icons with the extension ".oldinfo",
  211.                       otherwise delete them.
  212.     Depth          -- The image depth of resulting icons.
  213. Menus:
  214.     Same as the menus in the @{"main
  215. window" link "main_win" 0}.
  216. Clicking on the close gadget will quit IconConvert.
  217. @endnode
  218. @node "palette_win" "Palette Window"
  219. @next "convmap_win"
  220. @prev "conv_win"
  221.     Palette Windows
  222.     ~~~~~~~~~~~~~~~
  223. Gadgets:
  224.     Palette -- A list of all colours in the palette, in the form 
  225.                "n: r, g, b" where n is the colour number, and r, g, and b
  226.                are the red, green and blue values for the colour. You can
  227.                scroll in the list with the cursor keys.
  228.     Colour  -- The currently selected colour.
  229.     Red     -- The red value of the selected colour.
  230.     Green   -- The green value...
  231.     Blue    -- The blue value...
  232. Menu:
  233.   Palette:
  234.     Load Palette       -- Load the palette from an ILBM file, which you
  235.                           choose in the file requester.
  236.     Get Screen Palette -- Get the Workbench screen palette.
  237.     Change Depth       -- Change the depth of the palette. A requester is
  238.                           opened. Set the new depth with the slider.
  239. Clicking on the close gadget will close the palette window.
  240. @endnode
  241. @node "convmap_win" "Conversion Map Window"
  242. @next "progress_win"
  243. @prev "palette_win"
  244.     Conversion Map Window
  245.     ~~~~~~~~~~~~~~~~~~~~~
  246. Gadgets:
  247.     List   -- A list of the conversion map in the form "x -> y" where x is
  248.               the colour in the in palette, and y is the colour in the out
  249.               palette x will be converted to. You can scroll in the list
  250.               with the up and down cursor keys.
  251.     Slider -- With this you can change y. You can use the left and right
  252.               cursor keys to set y.
  253.     OK     -- Your conversion map will be used, and the conversion will
  254.               continue.
  255.     Cancel -- The old conversion map will be used, and the conversion will
  256.               continue.
  257.     Abort Conversion -- Abort the conversion and quit IconConvert.
  258. @endnode
  259. @node "progress_win" "Progress Window"
  260. @next "shell_use"
  261. @prev "convmap_win"
  262.     Progress Window
  263.     ~~~~~~~~~~~~~~~
  264. Gadgets:
  265.     Text box -- Displays the icon which is being converted.
  266.     Progress -- Displays how many icons that has been converted.
  267.     Cancel   -- Abort conversion and quit IconConvert.
  268. @endnode
  269. @node "shell_use" "Shell Use"
  270. @next "bugs"
  271. @prev "workbench_use"
  272.     Shell Use
  273.     ~~~~~~~~~
  274. The argument template:
  275. ICON/M,INPAL=INPALETTEFILE/K,OUTPAL=OUTPALETTEFILE/K,DEPTH/N,ALL/S,
  276. SAVEOLD/S,DIRICONS/S,QUIET/S,GUI/S
  277.  ICON     -- Icons and directories with icons to be converted. Directories
  278.              must end in a '/', but icons doesn't have to end in '.info'.
  279.  INPAL    -- Load this ILBM file's palette as in palette. If not specified
  280.              use the Workbench screen palette.
  281.  OUTPAL   -- Load this ILBM file's palette as out palette. If not specified
  282.              use the Workbench screen palette.
  283.  DEPTH    -- The resulting icons' image depth. If not specified use the
  284.              depth of the out palette.
  285.  ALL      -- Convert icons in subdirectories to directories specified with
  286.              ICON.
  287.  SAVEOLD  -- Save the old icons with the extension ".oldinfo", otherwise
  288.              delete them.
  289.  DIRICONS -- Add the icons to the directories to the list.
  290.  QUIET    -- Don't output the icons being converted.
  291.  GUI      -- Open the @{"GUI
  292. interface" link "workbench_use" 0} with the settings from the command
  293.              line.
  294. IconConvert can be made resident.
  295. @endnode
  296. @node "bugs" "Bugs"
  297. @next "to_do"
  298. @prev "shell_use"
  299.     Bugs
  300.     ~~~~
  301. It's not a real bug, but if IconConvert runs out of memory when adding icons
  302. to the list or during conversion, it will just skip this icon without
  303. notifying the user. The problem is that if IconConvert can't allocate a few
  304. hundred bytes, there isn't enough free memory to pop up a  requester saying
  305. this, and I don't think this situation is serious enough  to use an alert.
  306. @endnode
  307. @node "to_do" "To Do"
  308. @next "history"
  309. @prev "bugs"
  310.     To Do
  311.     ~~~~~
  312.  * Improve colour conversion. Maybe an option to produce dithered colours?
  313.  * Open a screen, so IconConvert can show the colours instead of just the
  314.    red/green/blue values in the @{"palette
  315. windows" link "palette_win" 0}.
  316.  * On line help.
  317.  * Localization.
  318. @endnode
  319. @node "history" "Version History"
  320. @next "contact"
  321. @prev "to_do"
  322.     Version History
  323.     ~~~~~~~~~~~~~~~
  324. **** 1.2 (1 Dec. 1995) ****
  325. New features:
  326. * Added @{"tooltypes" link "tooltypes" 0}.
  327. * Now will drawer icons be included to the list when you add a drawer to 
  328.   it.
  329. * The @{"main
  330. window" link "main_win" 0} menus are now menus to the @{"conversion
  331. settings" link "conv_win" 0} window 
  332.   too.
  333. **** 1.1 (8 Nov. 1995) ****
  334. This is so embarrassing -- obviously I hadn't bug tested IconConvert enough.
  335. I also forgot to document the @{"AppWindow
  336. function" link "workbench_use" 0}, but that's alright because
  337. it didn't work anyway...
  338. Bug fixes:
  339. * Icons dropped on the main window or choosed at start from the Workbench
  340.   had the wrong path (drawers were alright though.)
  341. * Memory loss in the colour conversion routine.
  342. **** 1.0 (3 Nov. 1995) ****
  343. Initital release.
  344. @endnode
  345. @node "contact" "Contacting the Author"
  346. @next "Main"
  347. @prev "history"
  348.     Contacting the Author
  349.     ~~~~~~~~~~~~~~~~~~~~~
  350. I'd be glad to hear from you -- bugs, ideas, constructive criticism,
  351. whatever!
  352. My address is:
  353.     Peter Liljenberg
  354.     Tjureda 823 B
  355.     S-360 40 Rottne
  356.     Sweden
  357. This address should be valid until July 1996.
  358. E-mail:
  359.     dan.eriksson@vxjkatedral.se (lipnv3c, Peter Liljenberg)
  360. N.B. Don't forget the part in the brackets, remember at least 'lipnv3c'.
  361. This address may change in January 1996, and is definitly not valid after
  362. May 1996.
  363. @endnode
  364.